API Documentation
Public Member Functions | List of all members
nkGraphics::RasterState Class Referenceabstract

Holds information about a raster state. More...

Inheritance diagram for nkGraphics::RasterState:
nkGraphics::Resource nkExport::Exportable

Public Member Functions

 RasterState ()
 
virtual ~RasterState ()
 
virtual FILL_MODE getFillMode () const =0
 
virtual CULL_MODE getCullMode () const =0
 
virtual bool getFrontCounterClockwise () const =0
 
virtual int getDepthBias () const =0
 
virtual float getDepthBiasClamp () const =0
 
virtual float getSlopeScaledDepthBias () const =0
 
virtual bool getDepthClipEnabled () const =0
 
virtual bool getScissorEnabled () const =0
 
virtual bool getMultiSampleEnabled () const =0
 
virtual bool getAntiAliasedLineEnabled () const =0
 
virtual unsigned int getForcedSampleCount () const =0
 
virtual bool getConservativeRasterizationEnabled () const =0
 
virtual void setFillMode (FILL_MODE value)=0
 
virtual void setCullMode (CULL_MODE value)=0
 
virtual void setFrontCounterClockwise (bool value)=0
 
virtual void setDepthBias (int value)=0
 
virtual void setDepthBiasClamp (float value)=0
 
virtual void setSlopeScaledDepthBias (float value)=0
 
virtual void setDepthClipEnabled (bool value)=0
 
virtual void setScissorEnabled (bool value)=0
 
virtual void setMultiSampleEnabled (bool value)=0
 
virtual void setAntiAliasedLineEnabled (bool value)=0
 
virtual void setForcedSampleCount (unsigned int value)=0
 
virtual void setConservativeRasterizationEnabled (bool value)=0
 
virtual void resetToDefault ()=0
 
virtual void exportClassToTree (nkExport::Node *rootNode) override
 
virtual void importClassFromTree (nkExport::Node *rootNode) override
 
- Public Member Functions inherited from nkGraphics::Resource
 Resource ()
 
 Resource (const nkMemory::StringView &path)
 
virtual ~Resource ()
 
bool isReadyForRendering () const
 
bool isUnloaded () const
 
RESOURCE_LOAD_STATE getLoadState () const
 
nkMemory::StringView getResourcePath () const
 
RESOURCE_TYPE getResourceTypeName () const
 
nkMemory::StringView getResourceName () const
 
bool getHidden () const
 
bool getGpuUploadCanBeDeferred () const
 
virtual void setResourcePath (const nkMemory::StringView &path)
 
void setResourceName (const nkMemory::StringView &name)
 
void setHidden (bool value)
 
void setGpuUploadCanBeDeferred (bool value)
 
virtual bool load ()=0
 
virtual void unload ()=0
 
- Public Member Functions inherited from nkExport::Exportable
 Exportable ()
 
virtual ~Exportable ()
 

Detailed Description

Holds information about a raster state.

A raster state drives how the rasterization occur for primitives rendered.

Constructor & Destructor Documentation

◆ RasterState()

nkGraphics::RasterState::RasterState ( )

◆ ~RasterState()

virtual nkGraphics::RasterState::~RasterState ( )
virtual

Destructor.

Member Function Documentation

◆ getFillMode()

virtual FILL_MODE nkGraphics::RasterState::getFillMode ( ) const
pure virtual
Returns
The fill mode used.

◆ getCullMode()

virtual CULL_MODE nkGraphics::RasterState::getCullMode ( ) const
pure virtual
Returns
The cull mode used.

◆ getFrontCounterClockwise()

virtual bool nkGraphics::RasterState::getFrontCounterClockwise ( ) const
pure virtual
Returns
Whether the front side of primitives is chosen according to their point being counter clockwise (true) or not (false).

◆ getDepthBias()

virtual int nkGraphics::RasterState::getDepthBias ( ) const
pure virtual
Returns
The depth bias used.

◆ getDepthBiasClamp()

virtual float nkGraphics::RasterState::getDepthBiasClamp ( ) const
pure virtual
Returns
The depth bias clamp used.

◆ getSlopeScaledDepthBias()

virtual float nkGraphics::RasterState::getSlopeScaledDepthBias ( ) const
pure virtual
Returns
The slope scaled depth bias used.

◆ getDepthClipEnabled()

virtual bool nkGraphics::RasterState::getDepthClipEnabled ( ) const
pure virtual
Returns
Whether depth clip is enabled (true) or not (false).

◆ getScissorEnabled()

virtual bool nkGraphics::RasterState::getScissorEnabled ( ) const
pure virtual
Returns
Whether the scissor test is enabled (true) or not (false).

◆ getMultiSampleEnabled()

virtual bool nkGraphics::RasterState::getMultiSampleEnabled ( ) const
pure virtual
Returns
Whether the multi sampling is enabled (true) or not (false).

◆ getAntiAliasedLineEnabled()

virtual bool nkGraphics::RasterState::getAntiAliasedLineEnabled ( ) const
pure virtual
Returns
Whether the lines are anti aliased (true) or not (false).

◆ getForcedSampleCount()

virtual unsigned int nkGraphics::RasterState::getForcedSampleCount ( ) const
pure virtual
Returns
The forced sample count used.

◆ getConservativeRasterizationEnabled()

virtual bool nkGraphics::RasterState::getConservativeRasterizationEnabled ( ) const
pure virtual
Returns
If conservative rasterization is enabled (true) or not (false).

◆ setFillMode()

virtual void nkGraphics::RasterState::setFillMode ( FILL_MODE  value)
pure virtual

Sets the fill mode when rasterizing.

Parameters
valueThe mode to use.

◆ setCullMode()

virtual void nkGraphics::RasterState::setCullMode ( CULL_MODE  value)
pure virtual

Sets the cull mode when rasterizing.

Parameters
valueThe mode to use.

◆ setFrontCounterClockwise()

virtual void nkGraphics::RasterState::setFrontCounterClockwise ( bool  value)
pure virtual

Sets whether the front of primitives should be chosen according to their points being declared counter clockwise or not.

Parameters
valueWhether the front is counter clockwise (true) or not (false).

◆ setDepthBias()

virtual void nkGraphics::RasterState::setDepthBias ( int  value)
pure virtual

Sets the depth bias used when rasterizing.

Parameters
valueThe value used.

◆ setDepthBiasClamp()

virtual void nkGraphics::RasterState::setDepthBiasClamp ( float  value)
pure virtual

Sets the bias clamp to use.

Parameters
valueThe value used.

◆ setSlopeScaledDepthBias()

virtual void nkGraphics::RasterState::setSlopeScaledDepthBias ( float  value)
pure virtual

Sets the slope scaled depth bias to use.

Parameters
valueThe value used.

◆ setDepthClipEnabled()

virtual void nkGraphics::RasterState::setDepthClipEnabled ( bool  value)
pure virtual

Sets whether the depth clipping is enabled or not.

Parameters
valueIf the clipping should be enabled (true) or not (false).

◆ setScissorEnabled()

virtual void nkGraphics::RasterState::setScissorEnabled ( bool  value)
pure virtual

Sets whether the scissor test should be enabled or not.

Parameters
valueIf the test should be enabled (true) or not (false).

◆ setMultiSampleEnabled()

virtual void nkGraphics::RasterState::setMultiSampleEnabled ( bool  value)
pure virtual

Sets whether multi sampling is enabled.

Parameters
valueIf multi sampling is enabled (true) or not (false).

◆ setAntiAliasedLineEnabled()

virtual void nkGraphics::RasterState::setAntiAliasedLineEnabled ( bool  value)
pure virtual

Sets whether the lines should be anti aliased.

Parameters
valueIf anti aliasing of lines is enabled (true) or not (false).

◆ setForcedSampleCount()

virtual void nkGraphics::RasterState::setForcedSampleCount ( unsigned int  value)
pure virtual

Sets the forced sample count used.

Parameters
valueThe value to use.

◆ setConservativeRasterizationEnabled()

virtual void nkGraphics::RasterState::setConservativeRasterizationEnabled ( bool  value)
pure virtual

Sets whether conservative rasterization is enabled or not.

Parameters
valueIf the option is enabled (true) or not (false).

◆ resetToDefault()

virtual void nkGraphics::RasterState::resetToDefault ( )
pure virtual

Resets the state to its default.

◆ exportClassToTree()

virtual void nkGraphics::RasterState::exportClassToTree ( nkExport::Node rootNode)
overridevirtual

Basic exporting capabilities.

Parameters
rootNodeThe tree to export to.

Implements nkExport::Exportable.

◆ importClassFromTree()

virtual void nkGraphics::RasterState::importClassFromTree ( nkExport::Node rootNode)
overridevirtual

Basic importing capabilities.

Parameters
rootNodeThe tree to import from.

Implements nkExport::Exportable.


The documentation for this class was generated from the following file: